> ## Documentation Index
> Fetch the complete documentation index at: https://sequence-0fb8d9e6-api_docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# useGetTokenBalancesDetails

> Hook for fetching detailed token balances including metadata across multiple chains

## Import

```tsx theme={null}
import { useGetTokenBalancesDetails } from '@0xsequence/hooks'
```

## Usage

```tsx theme={null}
import React from 'react'
import { useGetTokenBalancesDetails } from '@0xsequence/hooks'
import { ContractVerificationStatus } from '@0xsequence/connect'
import { useAccount } from 'wagmi'

function TokenPortfolio() {
  const { address } = useAccount()
  
  const {
    data: tokens,
    isLoading,
    isError
  } = useGetTokenBalancesDetails({
    chainIds: [1, 137], // Ethereum and Polygon
    filter: {
      accountAddresses: [address || ''],
      omitNativeBalances: false,
      contractStatus: ContractVerificationStatus.VERIFIED,
      // Optional: include only specific tokens
      contractWhitelist: [
        '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // USDC
        '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'  // WETH
      ]
    }
  })

  if (isLoading) return <div>Loading portfolio...</div>
  if (isError) return <div>Error loading portfolio</div>

  return (
    <div>
      {tokens?.map(token => (
        <div key={`${token.chainId}-${token.contractAddress}-${token.tokenID}`}>
          {token.contractType === 'ERC721' || token.contractType === 'ERC1155' ? (
            // NFT display
            <div className="nft-card">
              <img 
                src={token.tokenMetadata?.image} 
                alt={token.tokenMetadata?.name}
                width={200}
              />
              <h3>{token.tokenMetadata?.name}</h3>
              <p>{token.tokenMetadata?.description}</p>
              <div className="attributes">
                {token.tokenMetadata?.attributes?.map(attr => (
                  <span key={attr.trait_type}>
                    {attr.trait_type}: {attr.value}
                  </span>
                ))}
              </div>
            </div>
          ) : (
            // Fungible token display
            <div className="token-row">
              {token.contractInfo?.logoURI && (
                <img 
                  src={token.contractInfo.logoURI}
                  alt={token.contractInfo.symbol}
                  width={24}
                  height={24}
                />
              )}
              <span>{token.contractInfo?.symbol || 'Unknown Token'}</span>
              <span>Balance: {token.balance}</span>
              <span>Chain: {token.chainId}</span>
            </div>
          )}
        </div>
      ))}
    </div>
  )
}
```

## Return Type: `UseQueryResult<TokenBalance[]>`

The hook returns all properties from React Query's `UseQueryResult` with token balance data, including metadata. Here's the detailed structure:

```tsx theme={null}
interface TokenBalance {
  contractType: ContractType
  contractAddress: string
  accountAddress: string
  tokenID?: string
  balance: string
  blockHash: string
  blockNumber: number
  chainId: number
  uniqueCollectibles: string
  isSummary: boolean
  contractInfo?: ContractInfo
  tokenMetadata?: TokenMetadata
}
```

### Properties

#### data

`TokenBalance[] | undefined`

Array of token balance objects containing:

* `contractType`: Type of the token contract (NATIVE, ERC20, ERC721, ERC1155)
* `contractAddress`: Address of the token contract
* `accountAddress`: Address of the account holding the tokens
* `balance`: Token balance as a string (in base units)
* `chainId`: Chain ID where the token exists
* `blockHash`: Hash of the block where balance was last updated
* `blockNumber`: Block number where balance was last updated
* `tokenID`: (for NFTs) ID of the token
* `contractInfo`: Token contract information including name, symbol, decimals, and logo URL
* `tokenMetadata`: (for NFTs) Detailed token metadata including name, description, image URL, and attributes
* `uniqueCollectibles`: Number of unique collectibles
* `isSummary`: Whether the balance is a summary

#### isLoading

`boolean`

Loading state for the data fetch.

#### isError

`boolean`

Error state indicating if the query failed.

#### error

`Error | null`

Any error that occurred during data fetching.

## Parameters

The hook accepts two parameters:

### args: `GetTokenBalancesDetailsArgs`

```tsx theme={null}
interface GetTokenBalancesDetailsArgs {
  chainIds: number[]
  filter: {
    accountAddresses: string[]
    contractWhitelist?: string[]
    contractBlacklist?: string[]
    omitNativeBalances?: boolean
    contractStatus?: ContractVerificationStatus
  }
}
```

| Parameter                   | Type                         | Description                                        |
| --------------------------- | ---------------------------- | -------------------------------------------------- |
| `chainIds`                  | `number[]`                   | Array of chain IDs to fetch balances from          |
| `filter.accountAddresses`   | `string[]`                   | Array of account addresses to fetch balances for   |
| `filter.contractWhitelist`  | `string[]`                   | (Optional) Array of contract addresses to include  |
| `filter.contractBlacklist`  | `string[]`                   | (Optional) Array of contract addresses to exclude  |
| `filter.omitNativeBalances` | `boolean`                    | (Optional) If true, excludes native token balances |
| `filter.contractStatus`     | `ContractVerificationStatus` | (Optional) Filter for contract verification status |

### options: `BalanceHookOptions`

```tsx theme={null}
interface BalanceHookOptions {
  disabled?: boolean
  retry?: boolean
  hideCollectibles?: boolean
}
```

| Parameter          | Type      | Description                                               |
| ------------------ | --------- | --------------------------------------------------------- |
| `disabled`         | `boolean` | (Optional) Disable the query from automatically running   |
| `retry`            | `boolean` | (Optional) Whether to retry failed queries                |
| `hideCollectibles` | `boolean` | (Optional) If true, filters out ERC721 and ERC1155 tokens |